Package com.cisco.pt.ipc.sim
Interface PTPClock
- All Superinterfaces:
IPCObject
- All Known Implementing Classes:
PTPClockImpl
Information provided by the PKI file:
\class PTPClock
\brief This file holds CPTPClock class declaration
\example network().getDevice("Switch0").getProcess("CPTPProcess").getClock();
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptionvoidInformation provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:getMode()Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:voidinit()Information provided by the PKI file:voidsetDelayMechanism(DelayMechanism delay) Information provided by the PKI file:voidInformation provided by the PKI file:voidsetPriority1(int val) Information provided by the PKI file:voidsetPriority2(int val) Information provided by the PKI file:voidsetProfile(PTPProfile profile) Information provided by the PKI file:voidsetPtpTime(String time) Information provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Method Details
-
setMode
Information provided by the PKI file:
\brief Sets the mode. \param mode, the type of timer. Timer types: eE2etransparent = 0, eBoundary = 1, eForward = 2- Parameters:
mode- Takes in a parameter of mode
-
getMode
PTPMode getMode()Information provided by the PKI file:
\brief Returns the mode. \return PTPMode, the modes. Mode types: eE2etransparent = 0, eBoundary = 1, eForward = 2- Returns:
- PTPMode Returns a PTPMode
-
getModeStr
String getModeStr()Information provided by the PKI file:
\brief Returns the mode as a string. \return string, Mode strings: "e2etransparent", "boundary", "forward"- Returns:
- String Returns a String
-
getNumOfPorts
int getNumOfPorts()Information provided by the PKI file:
\brief Returns the number of ports. \return int, the number of ports.- Returns:
- int Returns a int
-
setProfile
Information provided by the PKI file:
\brief Sets the profile type. \param profile, the type of timer. Timer types: eDefault = 0, ePower = 1- Parameters:
profile- Takes in a parameter of profile
-
getProfile
PTPProfile getProfile()Information provided by the PKI file:
\brief Gets the profile type. \return PTPProfile, the profile type. Timer types: eDefault = 0, ePower = 1- Returns:
- PTPProfile Returns a PTPProfile
-
getProfileStr
String getProfileStr()Information provided by the PKI file:
\brief Returns the profile as a string. \return string, profile strings: "Default", "Power"- Returns:
- String Returns a String
-
setDelayMechanism
Information provided by the PKI file:
\brief Sets the delay mechanism type. \param delay, the type of delay. Timer types: eEnd2End = 0, ePeer2Peer = 1- Parameters:
delay- Takes in a parameter of delay
-
getDelayMechanism
int getDelayMechanism()Information provided by the PKI file:
\brief Gets the profile type. \return int, the profile type. Timer types: eDefault = 0, ePower = 1- Returns:
- int Returns a int
-
getDelayMechanismStr
String getDelayMechanismStr()Information provided by the PKI file:
\brief Returns the delay mechanisim as a string. \return string, profile strings: "End to End", "Peer to Peer"- Returns:
- String Returns a String
-
setPriority1
void setPriority1(int val) Information provided by the PKI file:
\brief Sets priority 1 to the given value. \param val, value to use.- Parameters:
val- Takes in a parameter of val
-
setPriority2
void setPriority2(int val) Information provided by the PKI file:
\brief Sets priority 2 to the given value. \param val, value to use.- Parameters:
val- Takes in a parameter of val
-
setPtpTime
Information provided by the PKI file:
\brief Sets ptp time to the given value. \param time, time to use.- Parameters:
time- Takes in a parameter of time
-
clearConfig
void clearConfig()Information provided by the PKI file:
\brief Clears the config. -
init
void init()Information provided by the PKI file:
\brief Runs the init setup.
-